Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Elegant CLI Builder
🚧 This project is under heavy development. More features are coming soon!
Install package:
# npm
npm install citty
# yarn
yarn add citty
# pnpm
pnpm install citty
Import:
// ESM
import { defineCommand, runMain } from "citty";
// CommonJS
const { defineCommand, runMain } = require("citty");
Define main command to run:
import { defineCommand, runMain } from "citty";
const main = defineCommand({
meta: {
name: "hello",
version: "1.0.0",
description: "My Awesome CLI App",
},
args: {
name: {
type: "positional",
description: "Your name",
required: true,
},
friendly: {
type: "boolean",
description: "Use friendly greeting",
},
},
run({ args }) {
console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
},
});
runMain(main);
defineCommand
defineCommand
is a type helper for defining commands.
runMain
Runs a command with usage support and graceful error handling.
createMain
Create a wrapper around command that calls runMain
when called.
runCommand
Parses input args and runs command and sub-commands (unsupervised). You can access result
key from returnd/awaited value to access command's result.
parseArgs
Parses input arguments and applies defaults.
renderUsage
Renders command usage to a string value.
showUsage
Renders usage and prints to the console
corepack enable
pnpm install
pnpm dev
Made with 💛 Published under MIT License.
Argument parser is based on lukeed/mri by Luke Edwards (@lukeed).
FAQs
Elegant CLI Builder
The npm package citty receives a total of 2,840,181 weekly downloads. As such, citty popularity was classified as popular.
We found that citty demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.